<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>My Project: syslog4cj.server.common.SyslogServerIF Interface Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">My Project
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespacesyslog4cj.html">syslog4cj</a></li><li class="navelem"><a class="el" href="namespacesyslog4cj_1_1server.html">server</a></li><li class="navelem"><a class="el" href="namespacesyslog4cj_1_1server_1_1common.html">common</a></li><li class="navelem"><a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerIF.html">SyslogServerIF</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerIF-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">syslog4cj.server.common.SyslogServerIF Interface Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for syslog4cj.server.common.SyslogServerIF:</div>
<div class="dyncontent">
 <div class="center">
  <img src="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerIF.png" usemap="#syslog4cj.server.common.SyslogServerIF_map" alt=""/>
  <map id="syslog4cj.server.common.SyslogServerIF_map" name="syslog4cj.server.common.SyslogServerIF_map">
<area href="classsyslog4cj_1_1server_1_1impl_1_1AbstractSyslogServer.html" alt="syslog4cj.server.impl.AbstractSyslogServer" shape="rect" coords="151,56,444,80"/>
<area href="classsyslog4cj_1_1server_1_1impl_1_1net_1_1TCPNetSyslogServer.html" alt="syslog4cj.server.impl.net.TCPNetSyslogServer" shape="rect" coords="0,112,293,136"/>
<area href="classsyslog4cj_1_1server_1_1impl_1_1net_1_1UDPNetSyslogServer.html" alt="syslog4cj.server.impl.net.UDPNetSyslogServer" shape="rect" coords="303,112,596,136"/>
<area href="classsyslog4cj_1_1server_1_1impl_1_1net_1_1TlsTCPNetSyslogServer.html" alt="syslog4cj.server.impl.net.TlsTCPNetSyslogServer" shape="rect" coords="0,168,293,192"/>
  </map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:aa575b67f77ac328d65df02674549d484"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerIF.html#aa575b67f77ac328d65df02674549d484">initialize</a> (String protocol, <a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerConfigIF.html">SyslogServerConfigIF</a> config):Unit</td></tr>
<tr class="separator:aa575b67f77ac328d65df02674549d484"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad1e8d1cae21af6a94f2e501d04dcc7fd"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerIF.html#ad1e8d1cae21af6a94f2e501d04dcc7fd">getProtocol</a> ():String</td></tr>
<tr class="separator:ad1e8d1cae21af6a94f2e501d04dcc7fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a381595e9ef3d87fde4d5a8d7976191d3"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerIF.html#a381595e9ef3d87fde4d5a8d7976191d3">getConfig</a> ():?<a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerConfigIF.html">SyslogServerConfigIF</a></td></tr>
<tr class="separator:a381595e9ef3d87fde4d5a8d7976191d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abef1015f737de707a15f704ae3696393"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerIF.html#abef1015f737de707a15f704ae3696393">run</a> ():Unit</td></tr>
<tr class="separator:abef1015f737de707a15f704ae3696393"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a81dc07f78c38c92ff753449f589d0028"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerIF.html#a81dc07f78c38c92ff753449f589d0028">getThread</a> ():?Future&lt; Unit &gt;</td></tr>
<tr class="separator:a81dc07f78c38c92ff753449f589d0028"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80845d0a2446e21ced62596c3b022d19"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerIF.html#a80845d0a2446e21ced62596c3b022d19">setThread</a> (Future&lt; Unit &gt; thread):Unit</td></tr>
<tr class="separator:a80845d0a2446e21ced62596c3b022d19"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba24ed1c90873ace1dc270d389d07e49"><td class="memItemLeft" align="right" valign="top">func&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerIF.html#aba24ed1c90873ace1dc270d389d07e49">shutdown</a> ():Unit</td></tr>
<tr class="separator:aba24ed1c90873ace1dc270d389d07e49"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SyslogServerIF 提供了所有 Syslog 服务器实现的公共接口。 </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a381595e9ef3d87fde4d5a8d7976191d3" name="a381595e9ef3d87fde4d5a8d7976191d3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a381595e9ef3d87fde4d5a8d7976191d3">&#9670;&#160;</a></span>getConfig()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.server.common.SyslogServerIF.getConfig </td>
          <td>(</td>
          <td class="paramtype"></td><td>)</td>
          <td>: ?<a class="el" href="interfacesyslog4cj_1_1server_1_1common_1_1SyslogServerConfigIF.html">SyslogServerConfigIF</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>获取当前 Syslog 服务器的配置对象。 </p><dl class="section return"><dt>Returns</dt><dd>返回 SyslogServerConfigIF 类型的配置对象 </dd></dl>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1server_1_1impl_1_1AbstractSyslogServer.html#a864b95a6f9e2bac1c9475cc00af63f71">syslog4cj.server.impl.AbstractSyslogServer</a>.</p>

</div>
</div>
<a id="ad1e8d1cae21af6a94f2e501d04dcc7fd" name="ad1e8d1cae21af6a94f2e501d04dcc7fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad1e8d1cae21af6a94f2e501d04dcc7fd">&#9670;&#160;</a></span>getProtocol()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.server.common.SyslogServerIF.getProtocol </td>
          <td>(</td>
          <td class="paramtype"></td><td>)</td>
          <td>: String</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>获取当前 Syslog 服务器使用的协议。 </p><dl class="section return"><dt>Returns</dt><dd>返回服务器的协议名称（例如，UDP、TCP） </dd></dl>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1server_1_1impl_1_1AbstractSyslogServer.html#a2b08213ffc74aad29c5f3019df56c9d6">syslog4cj.server.impl.AbstractSyslogServer</a>.</p>

</div>
</div>
<a id="a81dc07f78c38c92ff753449f589d0028" name="a81dc07f78c38c92ff753449f589d0028"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a81dc07f78c38c92ff753449f589d0028">&#9670;&#160;</a></span>getThread()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.server.common.SyslogServerIF.getThread </td>
          <td>(</td>
          <td class="paramtype"></td><td>)</td>
          <td>: ?Future&lt;Unit&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>获取与该服务器实例相关联的线程。 </p><dl class="section return"><dt>Returns</dt><dd>返回当前服务器实例的线程对象。 </dd></dl>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1server_1_1impl_1_1AbstractSyslogServer.html#a44a43097f9093cf54236a98b0e5b6fa1">syslog4cj.server.impl.AbstractSyslogServer</a>.</p>

</div>
</div>
<a id="aa575b67f77ac328d65df02674549d484" name="aa575b67f77ac328d65df02674549d484"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa575b67f77ac328d65df02674549d484">&#9670;&#160;</a></span>initialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.server.common.SyslogServerIF.initialize </td>
          <td>(</td>
          <td class="paramname"><em>protocol</em>:&#160;</td>
          <td class="paramtype">String, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramname"><em>config</em>:&#160;</td>
          <td class="paramtype">SyslogServerConfigIF&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td>: Unit</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>初始化 Syslog 服务器，设置协议和配置。</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">protocol</td><td>要使用的协议（如 UDP 或 TCP）。 </td></tr>
    <tr><td class="paramname">config</td><td>配置接口，包含服务器的配置信息。 </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1server_1_1impl_1_1AbstractSyslogServer.html#aa0b20280559a27674222875755e42185">syslog4cj.server.impl.AbstractSyslogServer</a>.</p>

</div>
</div>
<a id="abef1015f737de707a15f704ae3696393" name="abef1015f737de707a15f704ae3696393"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abef1015f737de707a15f704ae3696393">&#9670;&#160;</a></span>run()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.server.common.SyslogServerIF.run </td>
          <td>(</td>
          <td class="paramtype"></td><td>)</td>
          <td>: Unit</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>启动 Syslog 服务器的运行任务。 </p>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1server_1_1impl_1_1net_1_1UDPNetSyslogServer.html#acd5782f18b47f71d297af0d70e88a2cb">syslog4cj.server.impl.net.UDPNetSyslogServer</a>, and <a class="el" href="classsyslog4cj_1_1server_1_1impl_1_1net_1_1TCPNetSyslogServer.html#a18f259c3bee5d08e85d9c9ec19dd6ec8">syslog4cj.server.impl.net.TCPNetSyslogServer</a>.</p>

</div>
</div>
<a id="a80845d0a2446e21ced62596c3b022d19" name="a80845d0a2446e21ced62596c3b022d19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80845d0a2446e21ced62596c3b022d19">&#9670;&#160;</a></span>setThread()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.server.common.SyslogServerIF.setThread </td>
          <td>(</td>
          <td class="paramname"><em>thread</em>:&#160;</td>
          <td class="paramtype">Future&lt;Unit&gt;</td><td>)</td>
          <td>: Unit</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>设置与该服务器实例相关联的线程。 </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">thread</td><td>要设置的线程对象。 </td></tr>
  </table>
  </dd>
</dl>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1server_1_1impl_1_1AbstractSyslogServer.html#ad0596eeac360870d076b066c6f99934d">syslog4cj.server.impl.AbstractSyslogServer</a>.</p>

</div>
</div>
<a id="aba24ed1c90873ace1dc270d389d07e49" name="aba24ed1c90873ace1dc270d389d07e49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba24ed1c90873ace1dc270d389d07e49">&#9670;&#160;</a></span>shutdown()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">func syslog4cj.server.common.SyslogServerIF.shutdown </td>
          <td>(</td>
          <td class="paramtype"></td><td>)</td>
          <td>: Unit</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>停止并关闭 Syslog 服务器。 该方法将关闭服务器并清理所有资源。 </p>

<p>Implemented in <a class="el" href="classsyslog4cj_1_1server_1_1impl_1_1net_1_1UDPNetSyslogServer.html#a7b55a340f6880fce6eebb9127297e8f7">syslog4cj.server.impl.net.UDPNetSyslogServer</a>, <a class="el" href="classsyslog4cj_1_1server_1_1impl_1_1AbstractSyslogServer.html#a5ed97f84e27a62bee1a3d4f07d5ca624">syslog4cj.server.impl.AbstractSyslogServer</a>, and <a class="el" href="classsyslog4cj_1_1server_1_1impl_1_1net_1_1TCPNetSyslogServer.html#a31bc5479682574454ef00d6eaa75af03">syslog4cj.server.impl.net.TCPNetSyslogServer</a>.</p>

</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>src/server/common/<a class="el" href="syslog__server__if_8cj.html">syslog_server_if.cj</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
